Skip to content

chore(lint): flag doc links that aren't relative file paths - #4863

Draft
thetaPC wants to merge 1 commit into
absolute-md-linksfrom
doc-link-lint
Draft

thetaPC wants to merge 1 commit into
absolute-md-linksfrom
doc-link-lint

Conversation

@thetaPC

@thetaPC thetaPC commented Nov 18, 2026

Copy link
Copy Markdown
Contributor

Issue URL: N/A

What is the current behavior?

What is the new behavior?

  • npm run lint fails on:
    • A Markdown link without an extension, or one starting with /.
    • A JSX href that's relative or has an .mdx extension.
  • The check is a remark plugin in .remarkrc.mjs, run by eslint-plugin-mdx's mdx/remark rule. The rule goes from the preset's warn to error, since a warning doesn't fail the lint.
  • CONTRIBUTING says the lint enforces the link rule.

Does this introduce a breaking change?

  • Yes
  • No

Other information

The ESLint extension in VS Code shows these errors on the link as you type.

Stacked on #4862.

@thetaPC
thetaPC added this pull request to stack #4861 November 18, 2026 01:04
@vercel

vercel Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
ionic-docs Ready Ready Preview Nov 18, 2026 1:05am UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview — a30b018b Deployed Nov 18, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant